package com.zhangsun.yueBoot.framework.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * swagger2配置
 */
@Configuration
@EnableSwagger2
public class Swagger2Configuration {

    /**
     * 通过 createRestApi函数来构建一个DocketBean
     *
     * @return 返回
     */
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.zhangsun.yueBoot.admin"))
                .paths(PathSelectors.any())
                .build();
    }

    /**
     * api文档的详细信息函数
     *
     * @return 信息
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("APIs for yue-admin")
                .description("APIs for yue-admin")
                .contact(new Contact("zhangsun", "", ""))
                .version("1.0")
                .build();
    }

}
